home *** CD-ROM | disk | FTP | other *** search
/ CU Amiga Super CD-ROM 6 / CU Amiga Magazine's Super CD-ROM 06 (1996)(EMAP Images)(GB)(Track 1 of 4)[!][issue 1997-01].iso / cucd / games / tkgturbopatch / tkgpatch.doc < prev    next >
Text File  |  1996-10-31  |  7KB  |  173 lines
  1.    ***************************************************************
  2.    *     Alien Breed 3D II: The Killing Grounds TURBO patch      *
  3.    *                                                             *
  4.    * Author:        Aki Laukkanen (amlaukka@cs.helsinki.fi)      *
  5.    * with help from  Mikael Kalms (kalms@vasa.gavle.se)          *
  6.    * and           Jyrki Saarinen (jxsaarin@cs.helsinki.fi)      *
  7.    *                                                             *
  8.    * Download the newest version from aminet or my home page:    *
  9.    *              http://www.helsinki.fi/~amlaukka/              *
  10.    ***************************************************************
  11.  
  12.                    * Read this document, please! *
  13.  
  14.     OVERVIEW
  15.  
  16.     Alien Breed 3D II: The Killing Grounds by Team17 and Andy
  17. Clitheroe is the peak of the Doom clones for Amigas. It was met with
  18. acclaim and criticism in the general public. Most of the negative
  19. feedback geared towards the speed department which was a somewhat
  20. lacking on most of machines and just adequate on top-of-the-line
  21. equipment.
  22.  
  23.     FEATURES
  24.  
  25.     This patch is designed to address some of the quirks and problems.
  26. It replaces the somewhat outdated C2P routine of the game with a
  27. nearly optimal CPU only C2P solution by Mikael Kalms
  28. (kalms@vasa.gavle.se) and modified by me to support chunky and plane
  29. buffer x modulos. This routine is four times faster on fast 030
  30. processors and 040 upwards. The 2x? C2P routine is almost the same but
  31. modified by me to double pixels horizontally.
  32.  
  33.     Just the other day me and Jyrki Saarinen took the task of
  34. optimizing the drawing loops of the game. We got as far as patching
  35. normal and gouraud walls and ceiling and floor mapping routines. At
  36. the moment still unpatched inner loops include sprites and other
  37. lighting effects, transparent walls (if anybody finds them, please mail
  38. me), "water" bump mapping and polygon routines.
  39.  
  40.     FPS counter is one of the most useful features of this patch. With
  41. this you can check what the frame rate really is and not just make bad
  42. guesses. However at this point FPS counter isn't entirely reliable but
  43. the results are still comparable with others.
  44.  
  45.     Other unfinished features are the VGA patch which should promote
  46. the display to 30.00 KHz, 50 Hz one and Exit patch. These patches
  47. mightn't happen for a while too. There are some problems which I have
  48. to solve first.
  49.  
  50.     USAGE
  51.  
  52.     Copy the TKGPatch executable to your AB3DII directory and run it
  53. with your preferred settings.
  54.  
  55. TKGPatch E=TKGEXE/K,D=TKGDIR/K,C=C2P/S,V=VGA/S,Q=QUIT/S,EN=ENGINE/S,F=FPS/S
  56.  
  57.     - TKGEXE lets you set the name of the TKG executable. (PROGDIR:TKG
  58.       is default)
  59.     - TKGDIR is needed for the assigns to work. (PROGDIR: is default)
  60.     - C2P patches the chunky to planar routines.
  61.     - VGA alters the screen mode.
  62.     - QUIT adds an "exit" option.
  63.     - ENGINE optimizes some of the mapping routines a bit.
  64.     - FPS displays a FPS counter during the game.
  65.  
  66.     NOTES
  67.  
  68.     TKGPatch works by loading and relocating the TKG executable into
  69. memory and then adding patches to appropriate places. This is the
  70. reason why TKGPatch absolutely needs the original 4 MB executable
  71. (182820 bytes long) from install disks so no patched or otherwise
  72. altered executable will do. However if you are certain that you have
  73. the correct executable but TKGPatch still complains about incompatible
  74. executable then contact me (maybe there are several versions of TKG on
  75. sale).
  76.  
  77.     If you want to compare the existing and patched chunky to planar
  78. routines download aminet://game/gag/crap_c2p.lha and ask Jyrki
  79. Saarinen (jxsaarin@cs.helsinki.fi) to post his c2p benchmark to you.
  80.  
  81.     You might not notice any significant speedup with the ENGINE
  82. patch. TKG was programmed with slower approaches from the ground level
  83. so the most optimized loops couldn't be used. Also there is fairly
  84. big constant time which consists of outer loops of the mapping
  85. routines, BSP traversal and other game operations.
  86.  
  87.     If you are using the C2P patch in full screen mode, you might
  88. wonder why the screen is shifted 16 pixels to the right. This is
  89. because normally the address where the chunky buffer is c2p'ed isn't
  90. aligned by a long word and then the long word writes would be divided
  91. into to two word writes which result into a two times slower c2p.
  92.  
  93.     TKGPatch can't be started from Workbench at the moment. (It
  94. crashes miserably, sorry :( ) but all the tooltypes are implemented
  95. and equal to keywords from the command line interface. Also I need a
  96. better icon so please send your MagicWB, ordinary and NewIcons ones to
  97. me.
  98.  
  99.     VGA patch doesn't probably work at the moment. I already patched
  100. like tens of places but to no avail. I have to take a look a this some
  101. day. 
  102.  
  103.     Quit patch doesn't work either (It hangs on exit). I'll have to
  104. investigate it too.
  105.  
  106.     QUESTIONS AND ANSWERS
  107.  
  108.     Q: I got the patch working but TKG still isn't lightning fast in full
  109. screen 1x1 on my <insert computer model here>.
  110.  
  111.     A: There's not much I can do without rewriting huge parts of the
  112. game code, sorry. You'll have to live with it or get a faster
  113. computer.
  114.  
  115.     Q: Will this patch support graphic cards or other screen sizes?
  116.  
  117.     A: Most unlikely. Too much is hard coded in to the executable and
  118. there's too much code to rewrite.
  119.  
  120.     FUTURE
  121.  
  122.     Bug fixes and maybe an MMU speedup feature for 040/060.
  123.  
  124.     Some other features under consideration:
  125.  
  126.     - AmigaGuide documents
  127.     - a GUI frontend which would replace the current frontend by Daniel
  128. Hansen. This would be intuition friendly (maybe MUI) and allow easy
  129. access to all options of TKGPatch and the current frontend, adding
  130. several others.
  131.     - selectable module playing during the control screen, during game
  132. and when dying or completing a level. Send your suggestions please.
  133.     - Ability to change much of the graphics and sounds of the game.
  134. (If anyone wants to draw alternative panel graphics, please contact).
  135.     - Some one requested save option for key combinations.
  136.  
  137.     Of course I'm open for all suggestions so please e-mail me at
  138. amlaukka@cs.helsinki.fi.
  139.  
  140.     HISTORY
  141.  
  142.     33.1    22.10.96
  143.  
  144.             - created
  145.  
  146.     33.6    23.10.96
  147.  
  148.             - beta release for Andy Clitheroe
  149.  
  150.     34.0    26.10.96
  151.  
  152.             - first public beta version
  153.             - added VGA patch, QUIT patch and assigns patch (though not
  154.               all of them working atm) 
  155.             - removed NOPROTECT because of legal problems
  156.  
  157.  
  158.     34.4    30.10.96
  159.  
  160.             - first aminet release
  161.             - added 2x? C2P, ENGINE, FPS and other patches
  162.  
  163.     34.5    31.10.96
  164.  
  165.             - FPS counter is now always in the upper left corner of the
  166.               screen
  167.             - some documentation fixes
  168.             - added some icons
  169.             - large parts of the data needed by TKG are in chip ram
  170.               thus slowing things down. Made a little patch which
  171.               copied for example sin/cos table to fast ram and patched
  172.               all references to it. 
  173.